Skip to content

Comments

Add structured PR template and write-pr-description skill#673

Merged
renaudhartert-db merged 1 commit intomainfrom
renaud/pr-description-skill
Feb 21, 2026
Merged

Add structured PR template and write-pr-description skill#673
renaudhartert-db merged 1 commit intomainfrom
renaud/pr-description-skill

Conversation

@renaudhartert-db
Copy link
Contributor

Summary

Replaces the free-form PR template with a structured three-section format and
adds a /write-pr-description Claude command so agents and contributors can
generate high-quality PR descriptions automatically.

Why

The current PR template asks contributors to answer "what" and "why" but
provides little structure beyond that. In practice, PR descriptions vary widely
in quality and organization, making reviews harder and reducing the long-term
value of the git history.

A structured template (Summary / Why / What Changed) gives contributors a clear
framework to follow, while the Claude command automates the process for agent
workflows — reading the diff, analyzing the change, and producing a description
that follows the template.

What changed

Interface changes

None.

Behavioral changes

None. This only affects PR description authoring, not SDK behavior.

Internal changes

  • .github/PULL_REQUEST_TEMPLATE.md — Rewritten with three sections
    (Summary, Why, What Changed) and ordered sub-sections under "What Changed":
    Interface changes → Behavioral changes → Internal changes. Includes inline
    guidance and examples in HTML comments so it works standalone for non-Claude
    contributors.
  • .claude/commands/write-pr-description.md — New Claude command (invocable
    via /write-pr-description) with a four-phase workflow: gather context →
    analyze → write → update PR. References the PR template as the single source
    of truth for structure.

How is this tested?

N/A — no code changes, only documentation and tooling configuration.

NO_CHANGELOG=true

Replaces the free-form PR template with a three-section structure
(Summary / Why / What Changed) and adds a Claude command that agents
and contributors can invoke to generate high-quality PR descriptions.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Signed-off-by: Ubuntu <renaud.hartert@databricks.com>
@github-actions
Copy link

If integration tests don't run automatically, an authorized user can run them manually by following the instructions below:

Trigger:
go/deco-tests-run/sdk-java

Inputs:

  • PR number: 673
  • Commit SHA: 6a4ef1754728a16d69b1e994e9c2b7d2eb380183

Checks will be approved automatically on success.

Copy link
Member

@simonfaltum simonfaltum left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like good changes, we can always iterate from here

@renaudhartert-db renaudhartert-db added this pull request to the merge queue Feb 21, 2026
Merged via the queue into main with commit 464cabf Feb 21, 2026
16 checks passed
@renaudhartert-db renaudhartert-db deleted the renaud/pr-description-skill branch February 21, 2026 14:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants